//Granify Android SDK/com.granifyinc.granifysdk.models

Package-level declarations

[androidJvm]
Contains classes to be used when integrating with the Granify SDK.

Types

Name	Summary
Carter	[androidJvm] interface Carter Defines callbacks that Granify can call to add a product to the cart.
Currency	[androidJvm] enum Currency : Enum<Currency> Identifies a particular type of currency.
DiscountCode	[androidJvm] @Serializable data class DiscountCode(val code: String, val amount: Price) Represents an order discount code.
DisplayStatus	[androidJvm] enum DisplayStatus : Enum<DisplayStatus> Valid display status values that may be reported when the Granify engine decides to show a message to a shopper.
ErrorType	[androidJvm] enum ErrorType : Enum<ErrorType> Types of errors that may be reported by the Granify SDK.
MatchingGroup	[androidJvm] enum MatchingGroup : Enum<MatchingGroup> Matching groups that a shopper may be assigned to.
Navigator	[androidJvm] interface Navigator Defines callbacks that Granify can call to navigate to different pages within your application. These callbacks will be invoked when a user engages with the call-to-action on a Granify campaign.
Order	[androidJvm] data class Order@JvmOverloadsconstructor(val orderNumber: String, val lineItemsTotal: Price, val subtotal: Price, val totalTax: Price, val totalShipping: Price, val total: Price, val lineItems: HashMap<Product, Int>, val discountCodes: List<DiscountCode>, val financialStatus: String = defaultFinancialStatus, val currency: Currency = Currency.USD) Represents an order placed on the site.
PageIdentifier	[androidJvm] class PageIdentifier(val pageType: PageType, val path: String) Contains information about a page’s type and its unique path.
PageType	[androidJvm] @Serializable enum PageType : Enum<PageType> Page type values that represent different types of pages that may be present in an application.
Price	[androidJvm] @Serializable(with = PriceSerializer::class) open class Price Represents a non-negative monetary price value.
Product	[androidJvm] data class Product(val sku: String, val productId: String, val title: String, val price: Price, val regularPrice: Price, val image: URL? = null, val stock: ProductStock? = null, val reviews: ProductReviews? = null, val category: String? = null, val subCategory: String? = null, val color: String? = null, val size: String? = null, val childSiteOwnerId: SiteIdentifier? = null, val customProperties: Map<String, StringOrInt> = mapOf()) Represents a distinct product with basic identifiers, price, display information, and further optional detailed information.
ProductReviews	[androidJvm] open class ProductReviews Contains product review and rating information.
ProductStock	[androidJvm] data class ProductStock(val count: Int) Contains product stock information.
RestrictionState	[androidJvm] enum RestrictionState : Enum<RestrictionState> States governing when a campaign is allowed to be shown to a shopper.
ScrollableView	[androidJvm] sealed class ScrollableView : Scrollable A view that is scrollable.
SiteIdentifier	[androidJvm] @Serializable(with = SiteIdentifierSerializer::class) class SiteIdentifier Unique site identifier.
SliderMargins	[androidJvm] class SliderMargins(val left: Int, val top: Int, val right: Int, val bottom: Int) : Parcelable Represents a collection of margins that dictate where a Granify campaign slider can be displayed.
StringOrInt	[androidJvm] @Serializable(with = StringOrIntSerializer::class) sealed class StringOrInt Discriminated union type for a String or Int for use in Product.customProperties.
WishListItem	[androidJvm] @Serializable(with = WishListItemSerializer::class) data class WishListItem(val productId: String, val inStock: Boolean, val sku: String? = null, val price: Price? = null, val regularPrice: Price? = null, val title: String? = null, val image: URL? = null, val dateAdded: Date? = null, val priceWhenAdded: Price? = null) Represents a product within a wish list.